<!DOCTYPE html>
<html lang="en" dir="ltr">
<head>
  <meta charset="utf-8" />
  <title>opencpn:opencpn_user_manual:plugins:install_and_enable</title>
<meta name="generator" content="DokuWiki"/>
<meta name="robots" content="index,follow"/>
<meta name="keywords" content="opencpn,opencpn_user_manual,plugins,install_and_enable"/>
<link rel="search" type="application/opensearchdescription+xml" href="../lib/exe/opensearch.html" title="OpenCPN Manuals"/>
<link rel="start" href="install_and_enable.html"/>
<link rel="contents" href="install_and_enable.html" title="Sitemap"/>
<link rel="alternate" type="application/rss+xml" title="Recent Changes" />
<link rel="alternate" type="application/rss+xml" title="Current namespace" />
<link rel="alternate" type="text/html" title="Plain HTML" href="install_and_enable.html"/>
<link rel="alternate" type="text/plain" title="Wiki Markup" href="install_and_enable.html"/>
<link rel="canonical" href="http://localhost/dokuwiki/doku.php?id=opencpn:opencpn_user_manual:plugins:install_and_enable"/>
<link rel="stylesheet" type="text/css" href="../lib/exe/css.php.t.bootstrap3.css"/>
<!--[if gte IE 9]><!-->
<script type="text/javascript">/*<![CDATA[*/var NS='opencpn:opencpn_user_manual:plugins';var JSINFO = {"id":"opencpn:opencpn_user_manual:plugins:install_and_enable","namespace":"opencpn:opencpn_user_manual:plugins","confirm_delete":"Are you sure you want to delete this page?","doku_base":"\/dokuwiki\/","cg_rev":"","dw_version":49.5,"chrome_version":0,"hide_captcha_error":"none","ckg_dbl_click":"","ckg_canonical":0,"has_wrap":"Wrap","wrapDiv":"WRAP","wrapSpan":"wrap","ckgEdPaste":"off","rel_links":0,"isadmin":0,"isauth":0,"move_renameokay":false,"schemes":["http","https","telnet","gopher","wais","ftp","ed2k","irc","ldap"],"htmlok":0};
/*!]]>*/</script>
<script type="text/javascript" charset="utf-8" src="../lib/exe/jquery.php.t.bootstrap3.js"></script>
<script type="text/javascript" charset="utf-8" src="../lib/exe/js.php.t.bootstrap3.js"></script>
<!--<![endif]-->

    <script type="text/javascript">
    //<![CDATA[ 
    function LoadScript( url )
    {
     document.write( '<scr' + 'ipt type="text/javascript" src="..//url"><\/scr' + 'ipt>' ) ;        

    }
   function LoadScriptDefer( url )
    {
     document.write( '<scr' + 'ipt type="text/javascript" src="..//url" defer><\/scr' + 'ipt>' ) ;        

    }
//]]> 

 </script>
</head>
<body>
<div class="dokuwiki export">



<h1 class="sectionedit1" id="install_and_enable">Install and Enable</h1>
<div class="level1">

<p>
The core OpenCPN tries to keep features to a minimum so that it is lean, mean and easy to use. Features can still be added through the plugin infrastructure.
</p>

<p>
The release of OpenCPN 4.2 upgrades the user framework for Plugins to a newer version, which means it is not binary compatible with the previous releases and all Plugins for Windows and Linux must be rebuilt for compatibility.
</p>

<p>
These newly rebuilt plugins will not work with older versions of OpenCPN.
</p>

<p>
<img src="../opencpn/manual/4plugins.h.640_tok.075191_w.440.jpg" class="media" alt="" width="440" height="640" />
</p>

</div>
<!-- EDIT1 SECTION "Install and Enable" [20-563] -->
<h3 class="sectionedit2" id="opencpn_has_four_default_plugins_pre-installed">OpenCPN has four default plugins pre-installed:</h3>
<div class="level3">

<p>
<a href="included_plugins/grib_weather.html" class="wikilink1" title="opencpn:opencpn_user_manual:plugins:included_plugins:grib_weather">Grib Weather</a><br/>

<a href="included_plugins/dashboard.html" class="wikilink1" title="opencpn:opencpn_user_manual:plugins:included_plugins:dashboard">Dashboard</a><br/>

<a href="included_plugins/wmm.html" class="wikilink1" title="opencpn:opencpn_user_manual:plugins:included_plugins:wmm">WMM Plugin</a><br/>

<a href="included_plugins/chart_downloader.html" class="wikilink1" title="opencpn:opencpn_user_manual:plugins:included_plugins:chart_downloader">Chart Downloader</a>
</p>

</div>
<!-- EDIT2 SECTION "OpenCPN has four default plugins pre-installed:" [564-952] -->
<h3 class="sectionedit3" id="download_plugins">Download Plugins</h3>
<div class="level3">

<p>
Many more plugins are available. See below.<br/>

Go to the dedicated page for downloading plugins: <a href="http://opencpn.org/OpenCPN/info/downloadplugins.html" class="urlextern" title="http://opencpn.org/OpenCPN/info/downloadplugins.html" rel="nofollow">PlugIns</a><br/>

Currently there are about 20 different plugins available for download.<br/>

For a complete list of plugins read the <a href="http://www.cruisersforum.com/forums/f134/plugin-threads-list-100306.html#post1189427" class="urlextern" title="http://www.cruisersforum.com/forums/f134/plugin-threads-list-100306.html#post1189427" rel="nofollow"> recent posts in this forum thread</a>.
</p>

</div>
<!-- EDIT3 SECTION "Download Plugins" [953-1382] -->
<h3 class="sectionedit4" id="plugin_versions">Plugin Versions</h3>
<div class="level3">

<p>
The release of OpenCPN 4.2 upgrades the user frameworks for Plugins to a newer version, which means it is not binary compatible with the previous releases and all Plugins for Windows and Linux must be rebuilt for compatibility. It is expected that this Plugin interface will remain stable for some time so Plugins will work across different (future) versions of OpenCPN.
</p>

</div>
<!-- EDIT4 SECTION "Plugin Versions" [1383-1781] -->
<h3 class="sectionedit5" id="blacklisted_plugins">Blacklisted Plugins</h3>
<div class="level3">

<p>
Plugins or versions of plugins known to be problematic can be Blacklisted.
</p>

<p>
<img src="../opencpn/manual/33blacklist.h.136_tok.26648a_w.403.jpg" class="media" alt="" width="403" height="136" />
</p>

<p>
A dialog pops up for 5 seconds when starting OpenCPN, if a blacklisted plugin is detected. This will happen even if the plugin is not enabled. A number of plugins are blacklisted. They are, mainly, old problematic versions of plugins. There is always a newer version of a blacklisted plugin, or, in worst case scenario, one will soon be released.
</p>

</div>
<!-- EDIT5 SECTION "Blacklisted Plugins" [1782-2287] -->
<h3 class="sectionedit6" id="installing_a_plugin">Installing a Plugin</h3>
<div class="level3">

<p>
For <strong>Linux</strong>, place the downloaded “pluginxx.so” in {prefix}/lib/opencpn, which means /usr/lib/opencpn for a standard installation, using the provided packages. If you are compiling yourself {prefix} may be “/usr/local” instead of “/usr”. Check “opencpn.log” if necessary.
</p>

<p>
For <strong>Windows</strong> the downloaded file is usually an executable “.exe” installation file. Click on the file and follow the instructions. If the file is a “_.dll” place the downloaded “pluginxx.dll” in a “plugins” sub folder of your OpenCPN installation folder. A common location is C:\Program Files\OpenCPN\plugins.
</p>

<p>
Once the plugin is in the right directory, restart OpenCPN and proceed to enabling the plugin.
</p>

<p>
For <strong>Mac</strong> the plugin will come as a pkg file. Double-click the pkg file and follow the install instructions.
</p>

<p>
This will place the plugin files in the proper locations.
</p>

</div>
<!-- EDIT6 SECTION "Installing a Plugin" [2288-3174] -->
<h3 class="sectionedit7" id="enabling_a_plugin">Enabling a Plugin</h3>
<div class="level3">

<p>
Plugins are made available by clicking on the plugin in the Options→Plugins Tab. Once this is done, an “Enable” button appears. Pressing this button activates the plugin icon in the ToolBar and changes the the default “grayed out” text to black in the list. Not all plugins have an icon when active. For most plugins there is a “Preferences” Button for configuration.
</p>

<p>
When a plugin is disabled in the Options→Plugin tab, the plugin Icon disappears from the ToolBar.
</p>

<p>
The Plugin Icon works as a toggle switch for the plugin. Pressing the Grib Icon, for example, activates the Grib plugin. Pressing one more time deactivates it.
</p>

<p>
The WMM Icon uses a new feature, by displaying the magnetic variation, at the position of OwnShip in the button itself.
</p>

</div>
<!-- EDIT7 SECTION "Enabling a Plugin" [3175-3957] -->
<h3 class="sectionedit8" id="re-enable_a_plugin_after_a_plugin_update">Re-Enable a Plugin after a Plugin Update</h3>
<div class="level3">

<p>
Version 4.2 has implemented automatic reload of updated PlugIns by visiting the <strong>Options→Plugins</strong> screen.
</p>

<p>
Presumably the plugins are rescanned and loaded.
</p>

<p>
Previously, after a plugin was Disabled, the program had to be shut down and reopened for the full change of Opencpn status to occur. This is no longer necessary, simply go to the Option→Plugins screen and all plugins will be reloaded.
</p>

<p>
<img src="../opencpn/manual/plugins/grib/gribplugin33.h.722_tok.d9df8c_w.549.jpg" class="media" alt="" width="549" height="722" />
</p>

</div>
<!-- EDIT8 SECTION "Re-Enable a Plugin after a Plugin Update" [3958-4474] -->
<h3 class="sectionedit9" id="problems_with_plugins">Problems with Plugins</h3>
<div class="level3">

<p>
If you run into problems with plugins, first check what the opencpn.log file says.
</p>

<p>
For each plugin you will find lines similar to:
</p>
<pre class="code">    08:59:25 CEST: PlugInManager searching for PlugIns in location /usr/lib/opencpn\\
08:59:25 CEST: PlugInManager: Loading PlugIn: /usr/lib/opencpn/libweather_routing_pi.so\\
08:59:25 CEST: /usr/lib/opencpn/libweather_routing_pi.so\\
API Version detected: 110\\
PlugIn Version detected: 101</pre>

<p>
This example is from Linux.
</p>

<p>
On Windows systems the location of the log file will be displayed when you click “Help” (the ? mark icon) on the toolbar. Alternatively, to find the “opencpn.log” on your system read <a href="../getting_started/opencpn_installation.html" class="wikilink1" title="opencpn:opencpn_user_manual:getting_started:opencpn_installation">OpenCPN Installation</a>.
</p>

</div>
<!-- EDIT9 SECTION "Problems with Plugins" [4475-] -->
<!-- no cachefile used, but created /var/www/html/dokuwiki/data/cache/4/4e3bbf971d0191ac4d30b9e69b6c881b.xhtml -->
</div>
</body>
</html>
